Get all Person

GET /api/v1/Person/Getall

Description

This endpoint is used to retrieve all persons.

Tags:
Person

URL:
/api/v{version}/Person/Getall

ApiKey:
No API key required

Content-Type:
No request body

Query Parameters:

• GlobalSearch: string, optional

• Status: enum (Active/Inactive/All), optional

• UserId: string, optional

• TenantId: string, optional

• PageNumber: integer, required

• PageSize: integer, required

• version: string, required

• Accept-Language: header, optional, change the default response message language from English (en) to French (fr) or English (en)

Response:
Success, returns a list of all persons.

Error Codes:
None

Example:

bashCopy codeGET /api/v1/Person/Getall?PageNumber=1&PageSize=10
Accept-Language: en

/api/v1/Person/Getall?GlobalSearch=<string>&Status=2&UserId=<uuid>&TenantId=<uuid>&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
GlobalSearch	<string>
Status	2
UserId	<uuid>
TenantId	<uuid>
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "userId": `<uuid>`,
    "firstname": `<string>`,
    "middlename": `<string>`,
    "lastname": `<string>`,
    "identificationNumber": `<string>`,
    "phoneNumber": `<string>`,
    "phoneCode": `<string>`,
    "dateofBirth": `<dateTime>`,
    "gender": 1,
    "nationality": `<string>`,
    "email": `<string>`,
    "termsAndConditionsSignedAt": `<dateTime>`,
    "createdByAgent": `<boolean>`,
    "agentId": `<string>`,
    "status": 2,
    "kycRequired": `<boolean>`,
    "tenantId": `<uuid>`,
    "clientId": `<integer>`
  }
}

Response: 400

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 404

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}